         **************************************************************
         *               Vay - Un-Worked Design Patch                 *
         *                 Version 1 (24 Feb. 2017)                   *
         *            by Supper (suppertails66@gmail.com)             *
         **************************************************************

This is a patch that fixes many issues introduced in the US version of the Sega 
CD game Vay (Japanese title: "Vay: Ryuusei no Yoroi") by its publisher, Working 
Designs. The US version of the game heavily tampers with the gameplay by 
drastically increasing spell MP costs, reducing the effectiveness of weapons and 
armor, and increasing enemies' stats, among other changes. This patch aims to 
restore the gameplay to match the original Japanese version as closely as 
possible.

              ****************************************************
              *                     Changes                      *
              ****************************************************

* Enemy stats are restored to what they were in the Japanese game.
* Spell MP costs are reduced to their original values.
* Stat bonuses given by equipment are restored to their original levels.
* Inn costs are reduced to the original 4g.
* HP and MP are no longer restored on level up.
* The chest in the hidden Lorath Castle vault that contains 1,500g in the US 
version now contains 1,000g, per the original.
* Lynx's bar tab has been reduced from 20,000g to the original 1,000g.
* The US version inserted an event that caused an instant game over if Sirufa's 
teleportation was used without having all party members equipped with 
"Filtration Masks". This no longer occurs.
* The "Gold Vortex" chest in Vaygess has been replaced with its original 
contents.
* The US version moved the intro cutscene to before the title screen and made it 
unskippable if no save data exists. This patch leaves it before the title 
screen, but makes it skippable.

Other changes in the US version (e.g. the extra background animations, the 
places where voiceovers have been substituted for text, the horrible horrible 
made-up script) have been kept.

For specific details on the alterations in the US version, such as tables of 
stat changes and so on, see this page (which, depending on when you're reading 
this, I may not have actually written yet): 
https://tcrf.net/Vay#Regional_Differences

              ****************************************************
              *               Patching Instructions              *
              ****************************************************

--- WHAT YOU'LL NEED ---
* A BIN/CUE or ISO/WAV format disc image of the US version of Vay.
* If you're on Windows, the xdelta patching utility (http://xdelta.org/) is 
provided in this distribution. On other platforms, you'll need to acquire 
version 3.0.8 or later on your own.

--- AUTOMATIC PATCHING METHOD (WINDOWS) ---

If you're using Windows, move your disc image files into the same directory as 
the program and do one of these as appropriate:
  * If you have a BIN/CUE disc image, drag and drop the BIN file (or IMG file) 
onto binpatch.bat.
  * If you have an ISO/WAV disc image, drag and drop the ISO file onto 
isopatch.bat. Note that your ISO/WAV files must use standard naming and 
numbering, e.g. "File 01.iso", "File 02.wav", etc.

If everything works, this should produce the patched game under the name 
"VayUnWorked_##". To play it, make sure the file "VayUnWorked.cue" (included 
with the patch) is in the same directory as everything else and then load it in 
an emulator, or burn it to a CD for use on real hardware.

If this doesn't work, try using the manual patching method below to diagnose the 
problem.

--- MANUAL PATCHING METHOD---

--- CONVERTING FROM BIN/CUE TO ISO ---
If you have a BIN/CUE image (or the equivalent IMG/CUE), you'll need to convert 
it to ISO/WAV before you can patch it. I'd recommend using BinChunker (a.k.a. 
bchunk -- homepage http://he.fi/bchunk/) to do this.

* On Windows, you can use the included bchunk.exe (courtesy of elmer). If you 
don't want to use bchunk, there are also many "shareware"/commercial utilities 
that can do this task, though they may or may not output the same ISO as bchunk.
* On Linux, it should be available from your distro's repos, or of course you 
can build from source.
* On Mac, you can build from source, or perhaps get binaries wherever Mac people 
get their binaries from.

To convert, open a command prompt and navigate to the folder containing the 
BIN/CUE, then run the following command:

bchunk -w VayUS.bin VayUS.cue VayUS_

(substituting the names of your BIN/CUE files, obviously -- remember to put 
quotes around them if they have spaces in them. **Don't rename them** -- this 
will cause the conversion to fail unless you also modify the CUE file itself.) 
This should generate 22 files: VayUS_01.iso, VayUS_02.wav, VayUS_03.wav, and so 
on up to VayUS_22.wav.

--- PATCHING STEPS---
1. First, !!!***verify that your ISO has the correct MD5 hash***!!! It should be 
f7ffd152f59e50fd463d3c087bb146bc. If it isn't, the patch almost certainly won't 
work. You can obtain this by using the md5sum utility on *nix, or the FCIV 
utility (https://support.microsoft.com/en-us/kb/889768) on Windows.

2. Use xdelta to apply VayUnWorked.xdelta to your ISO. If you're using the 
command line, this would look something like:

xdelta3 -d -s VayUnWorked.xdelta VayUS_01.iso VayUnWorked_01.iso

If you use a GUI wrapper, it should be self-explanatory, but make sure the 
output file is named VayUnWorked_01.iso.

3. That's technically all the patching required, but assuming you want to play 
on an emulator, we now need to make sure the CD audio files are properly 
associated with the ISO or it will likely hang when it needs to play them. 
First, make sure your patched ISO is named VayUnWorked_01.iso, then rename the 
audio files produced from the BIN/CUE conversion process to VayUnWorked_02.wav, 
VayUnWorked_03.wav, etc.

4. A CUE file named VayUnWorked.cue is included with this patch. Move it to the 
same directory as your ISO and WAV files.

5. Test that the game works by loading VayUnWorked.cue in your emulator. Press 
A, B, or C at the BIOS startup screen to start the CD player, and make sure the 
number of tracks listed is 22.

--- TROUBLESHOOTING ---
* If the CD audio tracks go out of sync, and you patched an ISO/WAV rip, check 
your audio tracks. If they start with a couple of seconds of silence each, the 
software used to rip the disc chose to bake the pregaps into the audio files, 
which is not the standard format the included CUE file expects. You can rectify 
this by chopping the first couple of seconds of each audio file off in an editor 
such as Audacity.
* If the automatic patching method fails to produce any audio files, make sure 
all your files are named in the format "Filename ##.wav". The patcher expects to 
see a two-digit number directly before the file extension; without that, it 
can't find the tracks.
* If the patched ISO won't run, check the MD5 hashes of your original ISO and 
the patched ISO. The correct hashes are given in the steps above. If either of 
them doesn't match, try a different method for converting the BIN/CUE to ISO, or 
using a BIN/CUE generated by a different program.
* If loading VayUnWorked.cue doesn't work, try loading VayUnWorked_01.iso by 
itself. If that works, make sure all your files are named exactly as described 
above, and that the names in the CUE file match your audio files. CUE files are 
plaintext; just open it in Notepad or whatever.
* If your ISO has associated sound files in some format other than WAV (or your 
emulator doesn't support WAV files), you'll need to either convert them to WAV 
or modify the CUE file to use a different format. In the latter case, change 
(for example) all occurences of WAVE to MP3, and make sure the filenames are 
correct.
* If the game works fine but crashes when CD audio should play, your audio files 
aren't properly associated with the ISO. Check that your filenames match what's 
described in VayUnWorked.cue.

              ****************************************************
              *                  Known Issues                    *
              ****************************************************

None, yet...

              ****************************************************
              *                 Version History                  *
              ****************************************************

Version 1 (2/24/17)
  * Updated the included CUE file to fix issues with out-of-sync CD audio tracks 
on real hardware and accurate emulators. Patch content is unchanged.

Version 0 (1/24/17)
  * Initial release.

              ****************************************************
              *                  Special Thanks                  *
              ****************************************************

* chrisw80, for testing on real hardware and finding the CD audio syncing issues
* elmer
* Everyone on ROMhacking.net who provided feedback and support
